Resource URL: /platform/<<version=4>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

    Overview: This resource exposes a single OneFS network subnet.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: View a network subnet.

       URL: GET
            /platform/<<version=4>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "subnets": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "prefixlen": {
                "minimum": 1, 
                "type": "integer", 
                "description": "Subnet Prefix Length.", 
                "maximum": 128
              }, 
              "mtu": {
                "minimum": 576, 
                "type": "integer", 
                "description": "MTU of the subnet.", 
                "maximum": 9000
              }, 
              "description": {
                "type": "string", 
                "description": "A description of the subnet.", 
                "maxLength": 128
              }, 
              "base_addr": {
                "type": "string", 
                "description": "The base IP address."
              }, 
              "gateway_priority": {
                "minimum": 1, 
                "type": "integer", 
                "description": "Gateway priority.", 
                "maximum": 2147483647
              }, 
              "vlan_enabled": {
                "type": "boolean", 
                "description": "VLAN tagging enabled or disabled."
              }, 
              "sc_service_name": {
                "type": "string", 
                "description:": "Domain Name corresponding to the SmartConnect Service Address."
              }, 
              "dsr_addrs": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "List of Direct Server Return addresses."
              }, 
              "pools": {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Name of the pools in the subnet."
              }, 
              "sc_service_addr": {
                "type": "string", 
                "description": "The address that SmartConnect listens for DNS requests."
              }, 
              "id": {
                "type": "string", 
                "description": "Unique Subnet ID."
              }, 
              "groupnet": {
                "type": "string", 
                "description": "Name of the groupnet this subnet belongs to."
              }, 
              "addr_family": {
                "enum": [
                  "ipv4", 
                  "ipv6"
                ], 
                "type": "string", 
                "description": "IP address format."
              }, 
              "gateway": {
                "type": "string", 
                "description": "Gateway IP address."
              }, 
              "vlan_id": {
                "minimum": 2, 
                "type": "integer", 
                "description": "VLAN ID for all interfaces in the subnet.", 
                "maximum": 4094
              }, 
              "name": {
                "type": "string", 
                "description": "The name of the subnet.", 
                "maxLength": 32
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify a network subnet.

       URL: PUT
            /platform/<<version=4>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

Query arguments:
force=<boolean> force modifying this subnet even if it causes an MTU conflict.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "description": {
      "type": "string", 
      "description": "A description of the subnet.", 
      "maxLength": 128
    }, 
    "gateway_priority": {
      "minimum": 1, 
      "type": "integer", 
      "description": "Gateway priority.", 
      "maximum": 2147483647
    }, 
    "vlan_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "VLAN tagging enabled or disabled."
        }
      ]
    }, 
    "sc_service_name": {
      "type": "string", 
      "description:": "Domain Name corresponding to the SmartConnect Service Address."
    }, 
    "mtu": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 576, 
          "type": "integer", 
          "description": "MTU of the subnet.", 
          "maximum": 9000
        }
      ]
    }, 
    "sc_service_addr": {
      "type": "string", 
      "description": "The address that SmartConnect listens for DNS requests."
    }, 
    "prefixlen": {
      "minimum": 1, 
      "type": "integer", 
      "description": "Subnet Prefix Length.", 
      "maximum": 128
    }, 
    "dsr_addrs": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of Direct Server Return addresses."
    }, 
    "gateway": {
      "type": "string", 
      "description": "Gateway IP address."
    }, 
    "vlan_id": {
      "minimum": 2, 
      "type": "integer", 
      "description": "VLAN ID for all interfaces in the subnet.", 
      "maximum": 4094
    }, 
    "name": {
      "type": "string", 
      "description": "The name of the subnet.", 
      "maxLength": 32
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete a network subnet..

          URL: DELETE
               /platform/<<version=4>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

Query arguments:
force=<boolean> force deleting this subnet even if pools in other subnets rely
                on this subnet's SC VIP.

There is no JSON response body for this method.
